home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr39 / bpq406f.zip / PORTS.DOC < prev    next >
Text File  |  1992-09-06  |  13KB  |  545 lines
  1. Configuration file - BPQCFG.TXT
  2.  
  3.  
  4.  
  5. PORTS Section.
  6.  
  7.  
  8. This section of the configuration file defines the links from the switch
  9. to the outside world. These will normally be Radio links, but could also
  10. be a link to another computer running another copy of the switch, or similar
  11. software (eg NOS).
  12.  
  13. Please note that there is no relationship between the 'Virtual' COM ports
  14. defined in the TNCPORT section, which are used by the BBS or other program
  15. running abouve the switch, and these external links. You may use your 
  16. 'real' COM1 port to connect to a KISS TNC, even if you have defined a 
  17. 'Virtual' COM1 in the TNCPORT section. 
  18.  
  19.  
  20. There are two basic classes of links supported by the switch. One uses 
  21. normal ASYNC ports to communicate with TNCs running in KISS mode, and the
  22. other uses special HDLC cards which fit inside the PC, and interface to
  23. the radio via either an inbuilt or external  modem. Those currently supported
  24. are the PacCom PC120, DRSI PC-PA, Thor RLC100, and Baycom USCC-Karte.
  25.  
  26.  
  27. Interrupt levels may be shared by any cards with suitable hardware.
  28. Examples are all but the earliest DRSI cards, and a MS400 ASYNC card 
  29. modified as described by AA4RE in his MBBIOS documentation. However
  30. there is a significant overhead in using the shared interrupt feature
  31. - try to use it on relatively low speed links, and watch out for TX
  32. underruns/RX overuns.
  33.  
  34.  
  35. Each port is defined by a set of statements of the form:
  36.  
  37.  
  38. PORT
  39.  
  40.     PARAM=VALUE
  41.     ..
  42.     ..
  43.  
  44. ENDPORT
  45.  
  46.  
  47. Samples of various configurations are given later, but the full list
  48. of PARAM values supported is given below
  49.  
  50.  
  51. PORTNUM=n    
  52.  
  53.     Number for use in PORTS display, connects, etc. Default is next
  54.     sequential number.
  55.  
  56. ID=text string *
  57.  
  58.     Up to 30 chars, appears on PORTS display
  59.  
  60. TYPE=ASYNC/DRSI/PC120/RLC100/QUAD/INTERNAL/EXTERNAL/BAYCOM *
  61.  
  62.     Hardware type.
  63.  
  64.     ASYNC is for a normal ASYNC card, or a shared interrupt card 
  65.     such as the MS400
  66.  
  67.     PC120, DRSI, RLC100 BAYCOM are the internal HDLC cards,    the first
  68.     two support up to two channels, the others up to 4.
  69.  
  70.     QUAD is the Quadram Quadport, which allows up to 5 async links.
  71.     This version only supports a single Quadport. See later section
  72.     for setup details.
  73.  
  74.     INTERNAL defines a 'loopback' port - anything sent on it will be
  75.     received. Intended to allow KISS applications (eg TCP/IP) to talk
  76.     to the switch.
  77.  
  78.     EXTERNAL defines a user-supplied hardware driver.
  79.  
  80.  
  81. PROTOCOL=HDLC/KISS/NETROM *
  82.  
  83.     Protocol to be used on the link.
  84.  
  85.     NETROM is to connect to the async port of a real NETROM  
  86.     KISS is to connect to a KISS TNC
  87.  
  88.  
  89. IOADDR=xxxH *
  90.  
  91.     The base I/O address for the card. In hex, H is needed
  92.  
  93.  
  94. INTLEVEL=n *
  95.  
  96.     The interrupt level to be used. Any spare level may be used, up to
  97.     7 on an 8 bit machine, or 15 on a 16 bit machine. More than one card
  98.     may share a level if the hardware has the necessary logic. Also used
  99.     to define the software interrupt for EXTERNAL drivers.
  100.  
  101.  
  102. SPEED=nnnn *
  103.  
  104.     The radio speed for HDLC cards, or the async link speed for KISS
  105.     and NETROM links. If set to zero, the modem must supply a 1x clock. 
  106.     (TXC on RTXC pin, RXC on TRXC pin.)
  107.  
  108.  
  109. CHANNEL=A/B/..*
  110.  
  111.     Selects port on HDLC cards, dual port KISS (eg KPC4) or Multidropped KISS
  112.  
  113.  
  114. BBSFLAG=NOBBS
  115.  
  116.     Stops direct connects to the BBS on this port.
  117.  
  118.  
  119. QUALITY=nnn *
  120.  
  121.     Default quality for nodes heard on this port. Set to zero to suppress
  122.     all level 3/4 activity (including NODES broadcasts) on this port.
  123.  
  124.  
  125. MAXFRAME=n *
  126.  
  127.     Maximum outstanding frames. 
  128.  
  129.  
  130. TXDELAY=nnn *
  131.  
  132.     TX Keyup delay in milliseconds
  133.  
  134.  
  135. SLOTTIME=100 *
  136.  
  137.     CSMA interval timer (milliseconds)
  138.  
  139.  
  140. PERSIST=nnn *
  141.  
  142.     'Probability to transmit' value (1-255)
  143.  
  144.  
  145. FULLDUP=0/1
  146.  
  147.     Passed on to TNC if using KISS. Used to allow transmission whilst DCD
  148.     is active on HDLC cards, and to allow connection of a NETROM cluster
  149.     via a diode matrix.
  150.  
  151.  
  152. SOFTDCD=0/1
  153.  
  154.     If set to 1, system uses the detection of a valid frame to indicate that
  155.     the channel is busy, rather than the DCD signal from the modem. Used
  156.     only for HDLC cards.
  157.  
  158.  
  159. TXTAIL=nnnn
  160.  
  161.     TXTAIL timer in ms. Used only by KISS TNCs. If running on HF at 300 baud,
  162.     the default is probably too short. If others have trouble copying your
  163.     frames, try a value of 50 - 100.
  164.  
  165.  
  166. FRACK=nnnn *
  167.  
  168.     Level 2 timout in milliseconds
  169.  
  170.  
  171. RESPTIME=nnnn *
  172.  
  173.     Level 2 delayed ack timer in milliseconds
  174.  
  175.  
  176. RETRIES=n *
  177.  
  178.     Level 2 maximum retry value
  179.  
  180.  
  181. PACLEN=nnn *
  182.  
  183.     Default maximum packet length for this port
  184.  
  185.  
  186. CWID=CALL
  187.  
  188.    Only used on HDLC cards. CWID is sent every 29 mins.
  189.  
  190.  
  191. CWIDTYPE=ONOFF
  192.  
  193.    Send CWID using ON-OFF Keying. Without this param, the CWID will be sent
  194.    using normal modem tones. This is fine for low speed links, but faster
  195.    modems (eg the G3RUH) include scramblers which make it impossible to read
  196.    the CW. Note that the TX must have a pretty fast keying characteristic
  197.    to work with ON-OFF keying - certainly < 20mS.
  198.  
  199.  
  200. PORTCALL=CALL
  201. PORTALIAS=ALIAS
  202.  
  203.     Additional callsign/alias for level 2 connects to the node for this port.
  204.     Should not be the same as BBSCALL
  205.  
  206.  
  207. ALIAS_IS_BBS=0/1
  208.  
  209.     If set then PORTCALL and PORTALIAS access the BBS instead of the node. 
  210.  
  211.  
  212. VALIDCALLS=CALLS
  213.  
  214.     Up to about 40 callsigns, separated by single commas. If present, only
  215.     stations in the list will be allowed to connect to you on this port.
  216.     The SSID should not be specified, and multiple VALIDCALLS lines may be 
  217.     included. End all but the last line with commas. The total length of the
  218.     list, including commas, is 256 bytes.
  219.  
  220.  
  221. QUALADJUST=NNN
  222.  
  223.     Percentage to reduce the quality of a NODE in the NODES broadcast, if
  224.     the best neighbour is on the same port as the broadcast. Designed to
  225.     improve throughput if more than one channel is available, by discouraging
  226.     routes which cause a node to send a packet on the same port that it
  227.     received it on.
  228.  
  229.  
  230. DIGIFLAG=0/1/255
  231.  
  232.     Digipeat control flag for this port. 0 = dont digi, 1 = digi everything,
  233.     255 = digi UI frames only
  234.  
  235.  
  236. DIGIPORT=N
  237.  
  238.     Port to send digied frames on. Zero means the port it was received on,
  239.     any other number means send on that port. This is intended mainly to
  240.     allow a BBS on another machine, connected via a wire link, to send out
  241.     'MAIL FOR' messages.
  242.  
  243.  
  244. USERS=N
  245.  
  246.     This limits the number of L2 sessions to the supplied number. Zero means
  247.     no limit. The limit applies to all L2 sessions (even those with other
  248.     nodes), but is only checked for incoming connects (ie you can make
  249.     outgoing connects even when the limit is reached). Intended mainly to
  250.     control the number of users on busy user access ports (especially 2m).
  251.  
  252.  
  253. UNPROTO=
  254.  
  255.     Unproto destination and digi string for this port. Use commas between
  256.     calls, and dont include the VIA.
  257.  
  258.  
  259. L3ONLY=0/1
  260.  
  261.     If set, will stop users (but not HOST sessions) issuing downlink
  262.     connects on this port. 
  263.  
  264.  
  265. INTERLOCK=n
  266.  
  267.     Allows groups of ports to be defined which will not transmit at the same
  268.     time. A value of zero indicates no locking, if any other value is specifed
  269.     the code will make sure that no two ports with the same value can transmit
  270.     at the same time.
  271.  
  272.  
  273. TXPORT=n    
  274.  
  275.     Allows frames for this port to be transmitted on a different port.
  276.     This is for use when you are operating a central node, with a single
  277.     transmitter, and a number of receivers.
  278.  
  279.  
  280. MHEARD=Y/N
  281.  
  282.     Enables or disables the MHEARD function on this port. There is a slight
  283.     overhead in maintaining the MHEARD list, so if it is not needed (eg on
  284.     an internode port) it may be disabled. Default is enabled.
  285.  
  286.  
  287. KISSOPTIONS=POLLED,CHECKSUM,ACKMODE,SLAVE
  288.  
  289.     These select my extended KISS mode.
  290.     
  291.     These extended KISS options are supported by my BPQKISS EPROM for
  292.     the TNC2 and clones, and by special EPROMS for the KPC2, KPC4 and
  293.     KAM, available from Kantronics.
  294.  
  295.     POLLED selects multi-dropped mode, where the TNC only
  296.     transmits when requested (Polled) by the PC. This allows
  297.     several TNCs to share an async port without any risk of
  298.     collisions.
  299.     
  300.     CHECKSUM selects a mode where a checksum byte is appended
  301.     to each data message, and checked by the other end. This
  302.     reduces the risk of data corruption if errors occur on the
  303.     link from PC to TNCs. It may be used on its own, but should
  304.     always be used if POLLED mode is selected.
  305.     
  306.     ACKMODE enables the transmission of 'ACK required' frames.
  307.     There cause the TNC to send a reply when the frame has been
  308.     transmitted. This will improve link performance by avoiding
  309.     the possibility of a retry being sent before the original
  310.     frame has even left the TNC. This mode should always be used
  311.     if the TNC support it.
  312.     
  313.     SLAVE allows a PC to be multidropped along with one or more
  314.     KISS TNCs on a multidropped link. If you use SLAVE, you shouldnt
  315.     set POLLED, and you shouldnt use ACKMODE on either end. 
  316.  
  317.  
  318.  
  319. Parameters marked with a * must be included, the rest are optional. The 
  320. validation is not good, and defaults are generally zero, so if you miss 
  321. out any of the essential ones, odd things may well happen!
  322.  
  323.  
  324.  
  325. Sample PORT Configurations:
  326.  
  327.  
  328. 1. 2 Port DRSI card set for IO addr = 300h, int level 5
  329.  
  330.  
  331. PORT
  332.     ID=144.650 MHz 1200 Baud
  333.     TYPE=DRSI
  334.     PROTOCOL=HDLC
  335.     IOADDR=300H
  336.     INTLEVEL=5
  337.     SPEED=1200
  338.     CHANNEL=A
  339.     QUALITY=10
  340.     MAXFRAME=1
  341.     TXDELAY=500
  342.     SLOTTIME=100
  343.     PERSIST=64
  344.     FULLDUP=0
  345.     SOFTDCD=0
  346.     FRACK=7000
  347.     RESPTIME=2000
  348.     RETRIES=10
  349.     PACLEN=120
  350.     CWID=G8BPQ
  351.  
  352. ENDPORT
  353. ;
  354. PORT
  355.     ID=432.675 MHz 1200 Baud
  356.     TYPE=DRSI
  357.     PROTOCOL=HDLC
  358.     IOADDR=300H
  359.     INTLEVEL=5
  360.     SPEED=1200
  361.     CHANNEL=B
  362.     BBSFLAG=NOBBS            ; IF MY BBS LICENCE IS ONLY FOR 2M
  363.     QUALITY=10
  364.     MAXFRAME=1
  365.     TXDELAY=500
  366.     SLOTTIME=100
  367.     PERSIST=64
  368.     FULLDUP=0
  369.     SOFTDCD=0
  370.     FRACK=6000
  371.     RESPTIME=1500
  372.     RETRIES=10
  373.     PACLEN=120
  374.     CWID=G8BPQ
  375.     PORTCALL=G8BPQ
  376.     PORTALIAS=NOTTM
  377. ;
  378. ENDPORT
  379.  
  380.  
  381. 2. Standard KISS TNC on primary ASYNC card. (COM1). To use the secondary
  382.    ASYNC card (COM2), change IOADDR to 2F8H, and the INTLEVEL to 3.  
  383.  
  384.  
  385. PORT
  386.     ID=144.650 Mhz 1200 Baud
  387.     TYPE=ASYNC
  388.     PROTOCOL=KISS
  389.     IOADDR=3F8H
  390.     INTLEVEL=4
  391.     SPEED=9600
  392.     CHANNEL=A
  393.     QUALITY=10
  394.     MAXFRAME=2
  395.     TXDELAY=500
  396.     SLOTTIME=100
  397.     PERSIST=64
  398.     FULLDUP=0
  399.     FRACK=7000
  400.     RESPTIME=2000
  401.     RETRIES=10
  402.     PACLEN=120
  403.  
  404. ENDPORT
  405.  
  406. The second port of a multiport TNC (Such as the KAM or KPC 4) is defined as
  407. follows:
  408.  
  409.     ID=432.675 Mhz 1200 baud
  410.     TYPE=ASYNC
  411.     PROTOCOL=KISS
  412.     IOADDR=3F8H
  413.     INTLEVEL=4
  414.     SPEED=2400
  415.     CHANNEL=B
  416.     QUALITY=10
  417.     MAXFRAME=2
  418.     TXDELAY=500
  419.     SLOTTIME=100
  420.     PERSIST=64
  421.     FULLDUP=0
  422.     FRACK=7000
  423.     RESPTIME=2000
  424.     RETRIES=10
  425.     PACLEN=120
  426.     QUALADJUST=5
  427.  
  428. ENDPORT
  429.  
  430.  
  431.  
  432. 3. Quadram Quadport.
  433.  
  434. The Quadram Quadport card supports up to 5 (yes I know it says quadport!!)
  435. async ports. This version only supports one card - if anyone needs more,
  436. let me know. You do not need to define all ports, but you must start with
  437. the first, and not leave any gaps.
  438.  
  439. The card should be configured with first port at 280h, and software 
  440. selectable interrupts (3 or 4 may be used)
  441.  
  442. The card will support KISS TNCS (either normal, or KPC4 type dual port), or
  443. NETROM links (or a combination of both). 
  444.  
  445.  
  446. The following sample config file is for a Dual Port KPC4 on channel 1,
  447. a normal KISS TNC on channel 2, and a NETROM async link on channel 3.
  448.  
  449.  
  450. PORT
  451.     ID=KPC4 PORT 1
  452.     TYPE=QUAD
  453.     PROTOCOL=KISS
  454.     IOADDR=280H
  455.     INTLEVEL=3
  456.     SPEED=2400
  457.     CHANNEL=A
  458.     QUALITY=10
  459.     MAXFRAME=2
  460.     TXDELAY=500
  461.     SLOTTIME=100
  462.     PERSIST=64
  463.     FULLDUP=0
  464.     FRACK=7000
  465.     RESPTIME=2000
  466.     RETRIES=10
  467.     PACLEN=120
  468.  
  469. ENDPORT
  470.  
  471. PORT
  472.     ID=KPC4 PORT 2
  473.     TYPE=QUAD
  474.     PROTOCOL=KISS
  475.     IOADDR=280H
  476.     INTLEVEL=3
  477.     SPEED=2400
  478.     CHANNEL=B
  479.     QUALITY=10
  480.     MAXFRAME=2
  481.     TXDELAY=500
  482.     SLOTTIME=100
  483.     PERSIST=64
  484.     FULLDUP=0
  485.     FRACK=7000
  486.     RESPTIME=2000
  487.     RETRIES=10
  488.     PACLEN=120
  489.  
  490. ENDPORT
  491.  
  492. PORT
  493.     ID=NORMAL KISS
  494.     TYPE=QUAD
  495.     PROTOCOL=KISS
  496.     IOADDR=290H
  497.     INTLEVEL=3
  498.     SPEED=2400
  499.     CHANNEL=A
  500.     QUALITY=10
  501.     MAXFRAME=2
  502.     TXDELAY=500
  503.     SLOTTIME=100
  504.     PERSIST=64
  505.     FULLDUP=0
  506.     FRACK=7000
  507.     RESPTIME=2000
  508.     RETRIES=10
  509.     PACLEN=120
  510.  
  511. ENDPORT
  512.  
  513. PORT
  514.     ID=NETROM BACKEND
  515.     TYPE=QUAD
  516.     PROTOCOL=NETROM
  517.     IOADDR=2A0H
  518.     INTLEVEL=3
  519.     SPEED=2400
  520.     CHANNEL=A
  521.     QUALITY=10
  522.     MAXFRAME=2
  523.     TXDELAY=500        ; THESE AREN'T USED, BUT I SUGGEST  
  524.     SLOTTIME=100        ; YOU PUT THEM IN IN CASE ONE DAY
  525.     PERSIST=64        ; THEY ARE!
  526.     FULLDUP=1        ; THIS IS NOW NEEDED FOR A SINGLE NETROM
  527.                 ; TNC. SET TO 0 IF USING A DIODE MATRIX.
  528.     SOFTDCD=0
  529.     FRACK=7000
  530.     RESPTIME=2000
  531.     RETRIES=10
  532.     PACLEN=120
  533.  
  534. ENDPORT
  535.  
  536.  
  537. 4. Baycom USCC.
  538.  
  539. This card has 4 ports, two running at 1200 (Ports A and B), one
  540. TTL port (Port C), and one G3RUH compatible 9600 bps port (Port D).
  541. The configuration is similar to the DRSI, except that port D should
  542. have SPEED=0 (Not SPEED=9600). 
  543.  
  544.  
  545.